test(logger): test logger does not format objects as expected #6083
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hweinstock
commented
Nov 21, 2024
| }) | ||
| }) | ||
|
|
||
| it('assigns schemas to the yaml extension', async function () { |
Contributor
Author
There was a problem hiding this comment.
when passing some objects through util.format I noticed it set a property _formatted (perhaps as a cache?), so without these changes the test fails. Also avoids some small code dupe.
Hweinstock
force-pushed
the
fixTestLogger
branch
from
0731ea7 to
e9ff8a3
Compare
justinmk3
reviewed
Nov 22, 2024
| * In-memory Logger implementation suitable for use by tests. | ||
| */ | ||
| export class TestLogger implements Logger { | ||
| export class TestLogger extends BaseLogger { |
Contributor
There was a problem hiding this comment.
Nice, was just thinking about this!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The test logger does not format additional arguements into the logs in the same way as ToolkitLogger.
Ex.
getLogger().debug('here is the obj: %O', obj)will produce twoLogEntriesone with"here is the obj: %O"and one with the object itself.This is problematic because it causes confusion (see: #5895 (comment)) and it also can cause
assertLogsContainto throw an error since there is now a non-string/error entry in the log entry list (see:aws-toolkit-vscode/packages/core/src/test/globalSetup.test.ts
Lines 171 to 185 in 338ea67
Solution
BaseLoggerto minimize implementation dupe.testLogger.util.format: https://github.com/nodejs/node/blob/3178a762d6a2b1a37b74f02266eea0f3d86603be/lib/internal/util/inspect.js#L2191-L2315License: I confirm that my contribution is made under the terms of the Apache 2.0 license.